-- Network Working Group S. Chisholm
-- Request for Comments: 4268 Nortel Networks
-- Category: Standards Track D. Perkins
-- SNMPinfo
-- November 2005-- Entity State MIBENTITY-STATE-TC-MIB DEFINITIONS::=BEGINIMPORTSMODULE-IDENTITY, mib-2 FROM SNMPv2-SMI
TEXTUAL-CONVENTIONFROM SNMPv2-TC;entityStateTc MODULE-IDENTITYLAST-UPDATED"200511220000Z"ORGANIZATION"IETF Entity MIB Working Group"CONTACT-INFO"General Discussion: entmib@ietf.org
To Subscribe:
http://www.ietf.org/mailman/listinfo/entmib
http://www.ietf.org/html.charters/entmib-charter.html
Sharon Chisholm
Nortel Networks
PO Box 3511 Station C
Ottawa, Ont. K1Y 4H7
Canada
schishol@nortel.com
David T. Perkins
548 Qualbrook Ct
San Jose, CA 95110
USA
Phone: 408 394-8702
dperkins@snmpinfo.com"DESCRIPTION"This MIB defines state textual conventions.
Copyright (C) The Internet Society 2005. This version
of this MIB module is part of RFC 4268; see the RFC
itself for full legal notices."
REVISION"200511220000Z"DESCRIPTION"Initial version, published as RFC 4268."::={ mib-2 130}EntityAdminState::=TEXTUAL-CONVENTIONSTATUScurrentDESCRIPTION" Represents the various possible administrative states.
A value of 'locked' means the resource is administratively
prohibited from use. A value of 'shuttingDown' means that
usage is administratively limited to current instances of
use. A value of 'unlocked' means the resource is not
administratively prohibited from use. A value of
'unknown' means that this resource is unable to
report administrative state."SYNTAXINTEGER{unknown (1),locked (2),shuttingDown (3),unlocked (4)}EntityOperState::=TEXTUAL-CONVENTION
STATUScurrentDESCRIPTION" Represents the possible values of operational states.
A value of 'disabled' means the resource is totally
inoperable. A value of 'enabled' means the resource
is partially or fully operable. A value of 'testing'
means the resource is currently being tested
and cannot therefore report whether it is operational
or not. A value of 'unknown' means that this
resource is unable to report operational state."SYNTAXINTEGER{unknown (1),
disabled (2),enabled (3),testing (4)}EntityUsageState::=TEXTUAL-CONVENTIONSTATUScurrentDESCRIPTION" Represents the possible values of usage states.
A value of 'idle' means the resource is servicing no
users. A value of 'active' means the resource is
currently in use and it has sufficient spare capacity
to provide for additional users. A value of 'busy'
means the resource is currently in use, but it
currently has no spare capacity to provide for
additional users. A value of 'unknown' means
that this resource is unable to report usage state."SYNTAXINTEGER{unknown (1),idle (2),active (3),busy (4)
}EntityAlarmStatus::=TEXTUAL-CONVENTIONSTATUScurrentDESCRIPTION" Represents the possible values of alarm status.
An Alarm [RFC3877] is a persistent indication
of an error or warning condition.
When no bits of this attribute are set, then no active
alarms are known against this entity and it is not under
repair.
When the 'value of underRepair' is set, the resource is
currently being repaired, which, depending on the
implementation, may make the other values in this bit
string not meaningful.
When the value of 'critical' is set, one or more critical
alarms are active against the resource. When the value
of 'major' is set, one or more major alarms are active
against the resource. When the value of 'minor' is set,
one or more minor alarms are active against the resource.
When the value of 'warning' is set, one or more warning
alarms are active against the resource. When the value
of 'indeterminate' is set, one or more alarms of whose
perceived severity cannot be determined are active
against this resource.
A value of 'unknown' means that this resource is
unable to report alarm state."SYNTAXBITS{unknown (0),
underRepair (1),critical(2),major(3),minor(4),-- The following are not defined in X.733warning (5),indeterminate (6)}EntityStandbyStatus::=TEXTUAL-CONVENTION
STATUScurrentDESCRIPTION" Represents the possible values of standby status.
A value of 'hotStandby' means the resource is not
providing service, but it will be immediately able to
take over the role of the resource to be backed up,
without the need for initialization activity, and will
contain the same information as the resource to be
backed up. A value of 'coldStandy' means that the
resource is to back up another resource, but will not
be immediately able to take over the role of a resource
to be backed up, and will require some initialization
activity. A value of 'providingService' means the
resource is providing service. A value of
'unknown' means that this resource is unable to
report standby state."SYNTAXINTEGER{unknown (1),hotStandby (2),coldStandby (3),providingService (4)}ENDENTITY-STATE-MIB DEFINITIONS::=BEGINIMPORTSMODULE-IDENTITY,OBJECT-TYPE,NOTIFICATION-TYPE, mib-2
FROM SNMPv2-SMI
DateAndTimeFROM SNMPv2-TC
MODULE-COMPLIANCE,OBJECT-GROUP,NOTIFICATION-GROUPFROM SNMPv2-CONF
entPhysicalIndex
FROM ENTITY-MIB
EntityAdminState,EntityOperState,EntityUsageState,
EntityAlarmStatus,EntityStandbyStatusFROM ENTITY-STATE-TC-MIB;entityStateMIB MODULE-IDENTITYLAST-UPDATED"200511220000Z"ORGANIZATION"IETF Entity MIB Working Group"CONTACT-INFO" General Discussion: entmib@ietf.org
To Subscribe:
http://www.ietf.org/mailman/listinfo/entmib
http://www.ietf.org/html.charters/entmib-charter.html
Sharon Chisholm
Nortel Networks
PO Box 3511 Station C
Ottawa, Ont. K1Y 4H7
Canada
schishol@nortel.com
David T. Perkins
548 Qualbrook Ct
San Jose, CA 95110
USA
Phone: 408 394-8702
dperkins@snmpinfo.com
"DESCRIPTION"This MIB defines a state extension to the Entity MIB.
Copyright (C) The Internet Society 2005. This version
of this MIB module is part of RFC 4268; see the RFC
itself for full legal notices."REVISION"200511220000Z"DESCRIPTION"Initial version, published as RFC 4268."
::={ mib-2 131}-- Entity State ObjectsentStateObjects OBJECTIDENTIFIER::={ entityStateMIB 1}entStateTable OBJECT-TYPESYNTAXSEQUENCEOF EntStateEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"A table of information about state/status of entities.
This is a sparse augment of the entPhysicalTable. Entries
appear in this table for values of
entPhysicalClass [RFC4133] that in this implementation
are able to report any of the state or status stored in
this table.
"::={ entStateObjects 1}entStateEntry OBJECT-TYPESYNTAX EntStateEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"State information about this physical entity."INDEX{ entPhysicalIndex }
::={ entStateTable 1}
EntStateEntry ::=SEQUENCE{
entStateLastChanged DateAndTime,
entStateAdmin EntityAdminState,
entStateOper EntityOperState,
entStateUsage EntityUsageState,
entStateAlarm EntityAlarmStatus,
entStateStandby EntityStandbyStatus}entStateLastChanged OBJECT-TYPE
SYNTAXDateAndTimeMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The value of this object is the date and
time when the value of any of entStateAdmin,
entStateOper, entStateUsage, entStateAlarm,
or entStateStandby changed for this entity.
If there has been no change since
the last re-initialization of the local system,
this object contains the date and time of
local system initialization. If there has been
no change since the entity was added to the
local system, this object contains the date and
time of the insertion."
::={ entStateEntry 1}entStateAdmin OBJECT-TYPESYNTAXEntityAdminStateMAX-ACCESSread-writeSTATUScurrentDESCRIPTION"The administrative state for this entity.
This object refers to an entities administrative
permission to service both other entities within
its containment hierarchy as well other users of
its services defined by means outside the scope
of this MIB.
Setting this object to 'notSupported' will result
in an 'inconsistentValue' error. For entities that
do not support administrative state, all set
operations will result in an 'inconsistentValue'
error.
Some physical entities exhibit only a subset of the
remaining administrative state values. Some entities
cannot be locked, and hence this object exhibits only
the 'unlocked' state. Other entities cannot be shutdown
gracefully, and hence this object does not exhibit the
'shuttingDown' state. A value of 'inconsistentValue'
will be returned if attempts are made to set this
object to values not supported by its administrative
model."::={ entStateEntry 2}
entStateOper OBJECT-TYPESYNTAXEntityOperStateMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The operational state for this entity.
Note that unlike the state model used within the
Interfaces MIB [RFC2863], this object does not follow
the administrative state. An administrative state of
down does not predict an operational state
of disabled.
A value of 'testing' means that entity currently being
tested and cannot therefore report whether it is
operational or not.
A value of 'disabled' means that an entity is totally
inoperable and unable to provide service both to entities
within its containment hierarchy, or to other receivers
of its service as defined in ways outside the scope of
this MIB.
A value of 'enabled' means that an entity is fully or
partially operable and able to provide service both to
entities within its containment hierarchy, or to other
receivers of its service as defined in ways outside the
scope of this MIB.
Note that some implementations may not be able to
accurately report entStateOper while the
entStateAdmin object has a value other than 'unlocked'.
In these cases, this object MUST have a value
of 'unknown'."
::={ entStateEntry 3}entStateUsage OBJECT-TYPESYNTAXEntityUsageStateMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The usage state for this entity.
This object refers to an entity's ability to service more
physical entities in a containment hierarchy. A value
of 'idle' means this entity is able to contain other
entities but that no other entity is currently
contained within this entity.
A value of 'active' means that at least one entity is
contained within this entity, but that it could handle
more. A value of 'busy' means that the entity is unable
to handle any additional entities being contained in it.
Some entities will exhibit only a subset of the
usage state values. Entities that are unable to ever
service any entities within a containment hierarchy will
always have a usage state of 'busy'. Some entities will
only ever be able to support one entity within its
containment hierarchy and will therefore only exhibit
values of 'idle' and 'busy'."::={ entStateEntry 4}entStateAlarm OBJECT-TYPE
SYNTAXEntityAlarmStatusMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The alarm status for this entity. It does not include
the alarms raised on child components within its
containment hierarchy.
A value of 'unknown' means that this entity is
unable to report alarm state. Note that this differs
from 'indeterminate', which means that alarm state
is supported and there are alarms against this entity,
but the severity of some of the alarms is not known.
If no bits are set, then this entity supports reporting
of alarms, but there are currently no active alarms
against this entity."::={ entStateEntry 5}entStateStandby OBJECT-TYPESYNTAXEntityStandbyStatusMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The standby status for this entity.
Some entities will exhibit only a subset of the
remaining standby state values. If this entity
cannot operate in a standby role, the value of this
object will always be 'providingService'."
::={ entStateEntry 6}-- NotificationsentStateNotifications OBJECTIDENTIFIER::={ entityStateMIB 0}entStateOperEnabled NOTIFICATION-TYPEOBJECTS{ entStateAdmin,
entStateAlarm
}STATUScurrentDESCRIPTION"An entStateOperEnabled notification signifies that the
SNMP entity, acting in an agent role, has detected that
the entStateOper object for one of its entities has
transitioned into the 'enabled' state.
The entity this notification refers can be identified by
extracting the entPhysicalIndex from one of the
variable bindings. The entStateAdmin and entStateAlarm
varbinds may be examined to find out additional
information on the administrative state at the time of
the operation state change as well as to find out whether
there were any known alarms against the entity at that
time that may explain why the physical entity has become
operationally disabled."::={ entStateNotifications 1}
entStateOperDisabled NOTIFICATION-TYPEOBJECTS{ entStateAdmin,
entStateAlarm }STATUScurrentDESCRIPTION"An entStateOperDisabled notification signifies that the
SNMP entity, acting in an agent role, has detected that
the entStateOper object for one of its entities has
transitioned into the 'disabled' state.
The entity this notification refers can be identified by
extracting the entPhysicalIndex from one of the
variable bindings. The entStateAdmin and entStateAlarm
varbinds may be examined to find out additional
information on the administrative state at the time of
the operation state change as well as to find out whether
there were any known alarms against the entity at that
time that may affect the physical entity's
ability to stay operationally enabled."::={ entStateNotifications 2}-- Conformance and ComplianceentStateConformance OBJECTIDENTIFIER::={ entityStateMIB 2}entStateCompliances OBJECTIDENTIFIER::={ entStateConformance 1}
entStateCompliance MODULE-COMPLIANCESTATUScurrentDESCRIPTION"The compliance statement for systems supporting
the Entity State MIB."MODULE-- this moduleMANDATORY-GROUPS{
entStateGroup
}GROUP entStateNotificationsGroup
DESCRIPTION"This group is optional."OBJECT entStateAdmin
MIN-ACCESSread-only
DESCRIPTION"Write access is not required."::={ entStateCompliances 1}entStateGroups OBJECTIDENTIFIER::={ entStateConformance 2}entStateGroup OBJECT-GROUPOBJECTS{
entStateLastChanged,
entStateAdmin,
entStateOper,
entStateUsage,
entStateAlarm,
entStateStandby
}STATUScurrentDESCRIPTION"Standard Entity State group."::={ entStateGroups 1}entStateNotificationsGroup NOTIFICATION-GROUPNOTIFICATIONS{
entStateOperEnabled,
entStateOperDisabled
}STATUScurrentDESCRIPTION"Standard Entity State Notification group."
::={ entStateGroups 2}END